home *** CD-ROM | disk | FTP | other *** search
/ Linux Cubed Series 3: Developer Tools / Linux Cubed Series 3 - Developer Tools.iso / devel / lang / lisp / stk-3.002 / stk-3 / STk-3.1 / Doc / Manual / stk.txt < prev    next >
Encoding:
Text File  |  1996-07-23  |  9.9 KB  |  265 lines
  1.  
  2.  
  3.  
  4. STk(n)                          A                          STk(n)
  5.  
  6.  
  7. _________________________________________________________________
  8.  
  9. NNAAMMEE
  10.        stk, snow - A Scheme interpreter using the Tk toolkit
  11.  
  12. SSYYNNOOPPSSIISS
  13.        ssttkk  [_o_p_t_i_o_n_s] [_a_r_g _a_r_g _._._.]
  14.        ssnnooww [_o_p_t_i_o_n_s] [_a_r_g _a_r_g _._._.]
  15.  
  16. OOPPTTIIOONNSS
  17.        ssttkk interpreter accepts several command-line options which
  18.        may be abbreviated, as long as the abbreviation  is  unam-
  19.        biguous  (e.g.  --hh,  --hhee, --hheell are three possibe abbrevia-
  20.        tions for the --hheellpp option).
  21.  
  22.  
  23.        --ddiissppllaayy _d_i_s_p_l_a_y
  24.                       Display (and screen) on  which  to  display
  25.                       window.
  26.  
  27.        --ffiillee _f_i_l_e_N_a_m_e Read  commands  from  _f_i_l_e_N_a_m_e  rather than
  28.                       standard input.  The last element in  _f_i_l_e_-
  29.                       _N_a_m_e  will  be  used  as  the title for the
  30.                       application and name of its interpreter for
  31.                       sseenndd  commands  (unless  overridden  by the
  32.                       --nnaammee option).
  33.  
  34.        --ggeeoommeettrryy _g_e_o_m_e_t_r_y
  35.                       Initial geometry to use for window.
  36.  
  37.        --nnaammee _n_a_m_e     Use _n_a_m_e as the title to  be  displayed  in
  38.                       the  window,  and as the name of the inter-
  39.                       preter for sseenndd commands.
  40.  
  41.        --nneeww--ccoolloorrmmaapp  Specifies that the main window should  have
  42.                       a new private colormap instead of using the
  43.                       default colormap for the screen.
  44.  
  45.        --ssyynncc          Execute  all   X   server   commands   syn-
  46.                       chronously,  so  that  errors  are reported
  47.                       immediately.   This  will  result  in  much
  48.                       slower  execution,  but  it  is  useful for
  49.                       debugging.
  50.  
  51.        --vviissuuaall _v_i_s_u_a_l      Specifies the visual to  use  for  the
  52.                            window._V_i_s_u_a_l  may  be one of the fol-
  53.                            lowing: _b_e_s_t, _d_i_r_e_c_t_c_o_l_o_r,  _g_r_a_y_s_c_a_l_e,
  54.                            _g_r_e_y_s_c_a_l_e,  _p_s_e_u_d_o_c_o_l_o_r,  _s_t_a_t_i_c_c_o_l_o_r,
  55.                            _s_t_a_t_i_c_g_r_a_y, _s_t_a_t_i_c_g_r_e_y, _t_r_u_e_c_o_l_o_r,  or
  56.                            _d_e_f_a_u_l_t
  57.  
  58.        --nnoo--ttkk         Don't initialize the Tk toolkit
  59.  
  60.        --llooaadd _f_i_l_e_N_a_m_e Evaluate  expressions contained in _f_i_l_e_N_a_m_e
  61.  
  62.  
  63.  
  64. July_1996                      3.1                              1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. STk(n)                          A                          STk(n)
  71.  
  72.  
  73.                       before reading  expressions  from  standard
  74.                       input.
  75.  
  76.        --iimmaaggee _f_i_l_e_N_a_m_e
  77.                       Restore  the state saved in _f_i_l_e_N_a_m_e by the
  78.                       _d_u_m_p primitive (Note: For now,  _d_u_m_p  works
  79.                       only  on SunOS 4.1.x, Linux 1.x (a.out for-
  80.                       mat) and FreeBSD).
  81.  
  82.        --cceellllss _n_u_m_b_e_r  Set the default size for the heap to _n_u_m_b_e_r
  83.                       cells.  The given number is also the amount
  84.                       of cells  used  when  extending  the  heap.
  85.                       Default value is 20000.
  86.  
  87.        --iinntteerraaccttiivvee   Tell the interpreter that it is used inter-
  88.                       actively (even if it doesn't think so).
  89.  
  90.        --hheellpp          Print a summary of the command-line options
  91.                       and exit.
  92.  
  93.        ----                  Pass  all  remaining arguments through
  94.                            to the script's aarrggvv variable  without
  95.                            interpreting  them.   This  provides a
  96.                            mechanism for passing  arguments  such
  97.                            as --nnaammee to a script instead of having
  98.                            wwiisshh interpret them.
  99. _________________________________________________________________
  100.  
  101.  
  102. DDEESSCCRRIIPPTTIIOONN
  103.        SSttkk is a Scheme R4RS interpreter which  provide  a  simple
  104.        access to the X11 Tk toolkit. If the --nnoo--ttkk option is pro-
  105.        vided to the interpreter, the Tk library is  not  initial-
  106.        ized  and  no  main  window is created.  If ssttkk is invoked
  107.        with no --ff option then it reads Scheme expressions  inter-
  108.        actively from standard input.  It will continue processing
  109.        commands until all windows have been deleted or until end-
  110.        of-file is reached on standard input.
  111.  
  112.  
  113.        SSnnooww  is a _l_i_g_h_t version of the ssttkk interpreter which does
  114.        not provide support for the Tk toolkit.  This  interpreter
  115.        does  not recognize the options --ddiissppllaayy, --ggeeoommeettrryy, --ssyynncc
  116.        and --nnoo--ttkk which are meaningless without Tk.  This  inter-
  117.        preter  is  called, rather than the standard one, when the
  118.        shell DISPLAY variable is not initialized.
  119.  
  120.  
  121.        If the --ffiillee option is provided  to  Tk,  then  ssttkk  reads
  122.        Scheme  forms  from  the  file  named in the --ffiillee option.
  123.        These forms will normally create an interactive  interface
  124.        consisting  of  one  or more widgets.  When the end of the
  125.        command file is reached, ssttkk will continue to respond to X
  126.        events until all windows have been deleted.
  127.  
  128.  
  129.  
  130. July_1996                      3.1                              2
  131.  
  132.  
  133.  
  134.  
  135.  
  136. STk(n)                          A                          STk(n)
  137.  
  138.  
  139.        The --iinntteerraaccttiivvee option forces the interpreter in interac-
  140.        tive mode. In this  mode,  standard  output  and  standard
  141.        error are unbuffered.  Use this option when you launch ssttkk
  142.        from eemmaaccss.
  143.  
  144.  
  145.  
  146. VVAARRIIAABBLLEESS
  147.        Following Scheme variables are set when SSttkk starts:
  148.  
  149.        **aarrggcc**         Contains a count of the number of _a_r_g argu-
  150.                       ments   (0  if  none),  not  including  the
  151.                       options described above.
  152.  
  153.        **aarrggvv**         Contains a Scheme list whose  elements  are
  154.                       the   _a_r_g   arguments  (not  including  the
  155.                       options described above), in order,  or  an
  156.                       empty list if there are no _a_r_g arguments.
  157.  
  158.        **pprrooggrraamm--nnaammee** Contains  _f_i_l_e_N_a_m_e  if  it  was  specified.
  159.                       Otherwise, contains the name by  which  ssttkk
  160.                       was invoked.
  161.  
  162.  
  163.  
  164. SSCCRRIIPPTT FFIILLEESS
  165.        If you create a STk script in a file whose first line is
  166.  
  167.               ##!!//uussrr//llooccaall//bbiinn//ssttkk --ff
  168.  
  169.        then  you  can  invoke  the script file directly from your
  170.        shell if you mark it as executable.  This assumes that ssttkk
  171.        has   been   installed   in   the   default   location  in
  172.        /usr/local/bin;  if it's  installed  somewhere  else  then
  173.        you'll have to modify the above line to match.
  174.  
  175.  
  176. EENNVVIIRROONNMMEENNTT VVAARRIIAABBLLEESS
  177.        ssttkk uses the following shell variables:
  178.  
  179.        _S_T_K___L_I_B_R_A_R_Y    This  variable  indicates where the library
  180.                       files are located. This variable allows  to
  181.                       overload  the  default  value of the Scheme
  182.                       variable _*_s_t_k_-_l_i_b_r_a_r_y_* which  is  automati-
  183.                       cally  calculated  by the interpreter.(i.e.
  184.                       _s_t_k or _s_n_o_w).
  185.  
  186.        _S_T_K___L_O_A_D___P_A_T_H  This  variable  serves  to  initialize  the
  187.                       _*_l_o_a_d_-_p_a_t_h_*  Scheme variable. This variable
  188.                       is a list of paths to try when  in  a  load
  189.                       command.
  190.  
  191.        _S_T_K___H_E_L_P___P_A_T_H  This  variable  serves  to  initialize  the
  192.                       _*_h_e_l_p_-_p_a_t_h_*  Scheme   variable.   It   must
  193.  
  194.  
  195.  
  196. July_1996                      3.1                              3
  197.  
  198.  
  199.  
  200.  
  201.  
  202. STk(n)                          A                          STk(n)
  203.  
  204.  
  205.                       contain  a  list  of documentation directo-
  206.                       ries. This variable is  used  by  the  help
  207.                       procedure.
  208.  
  209.  
  210.  
  211. FFIILLEESS
  212.        _._/_i_n_i_t_._s_t_k
  213.  
  214.        _$_S_T_K___L_I_B_R_A_R_Y_/_S_T_k_/_i_n_i_t_._s_t_k
  215.                       When  ssttkk  starts running, it tries to load
  216.                       the file _i_n_i_t_._s_t_k in the current directory.
  217.                       If  this  file  is not present, it tries to
  218.                       load this file in the SSTTkk__LLIIBBRRAARRYY directory
  219.                       (the  value of SSTTkk__LLIIBBRRAARRYY is automatically
  220.                       computed to be in a  sibling  directory  of
  221.                       the interpreter executable.
  222.  
  223.  
  224.        _~_/_._s_t_k_r_c       Standard  _i_n_i_t_._s_t_k  file  tries to load the
  225.                       file _~_/_._s_t_k_r_c. This file  can  be  used  to
  226.                       store  function  definitions  or  variables
  227.                       settings that you want to  be  executed  at
  228.                       each interpretater invocation.
  229.  
  230.  
  231. SSEEEE AALLSSOO
  232.        wish(1)
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262. July_1996                      3.1                              4
  263.  
  264.  
  265.